/**
 * # 参数列表实体类:
 *  Create - 写入数据操作记录
 * 
 * # 描述:
 *  创建一条新的数据操作日志记录。
 *  
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package com.waln.log.op.args;

/**
 * 功能 写入数据操作记录 的参数列表。
 */
@pittypat.FunctionAnnotation(transaction = true)
public final class Create extends pittypat.FunctionArgs {
	/**
	 * 用户 Id。
	 * <p>
	 * 进行数据操作的目标用户的 Id，如果是系统操作，则为 null。
	 */
	@pittypat.ParameterAnnotation(position = 0, role = pittypat.ParameterRole.USER_ID)
	public java.util.UUID userId;

	/**
	 * 操作类型代码。
	 * <p>
	 * 操作的类型代码：1-查询、2-添加、4-更新、8-删除、16-其他。
	 */
	@pittypat.ParameterAnnotation(position = 1)
	public Byte opType;

	/**
	 * 数据库表名称。
	 * <p>
	 * 所操作的目标数据库表的名称，多个之间使用 ',' 分隔。
	 */
	@pittypat.ParameterAnnotation(position = 2, maxLength = 200)
	public String tableNames;

	/**
	 * 存储过程名称。
	 * <p>
	 * 执行操作的存储过程或函数的名称。
	 */
	@pittypat.ParameterAnnotation(position = 3, maxLength = 128)
	public String procName;

	/**
	 * 是否成功。
	 * <p>
	 * 指示操作是否已经成功。
	 */
	@pittypat.ParameterAnnotation(position = 4)
	public Boolean success;

	/**
	 * 操作摘要。
	 * <p>
	 * 操作的摘要信息。
	 */
	@pittypat.ParameterAnnotation(position = 5, maxLength = 200)
	public String summary;

	/**
	 * 消息正文。
	 * <p>
	 * 对数据库操作的详细说明信息。
	 */
	@pittypat.ParameterAnnotation(position = 6, maxLength = 20000)
	public String body;

	/**
	 * 消息 Id。
	 * <p>
	 * 日志消息的 Id。
	 */
	@pittypat.ParameterAnnotation(position = 7, direction = pittypat.ParameterDirection.OUT)
	public Long id;

	/**
	 * 初始化 Create 类的一个新实例。
	 */
	public Create() {
		super();

		// 用户 Id
		this.userId = null;
		// 操作类型代码
		this.opType = null;
		// 数据库表名称
		this.tableNames = null;
		// 存储过程名称
		this.procName = null;
		// 是否成功
		this.success = null;
		// 操作摘要
		this.summary = null;
		// 消息正文
		this.body = null;
		// 消息 Id
		this.id = null;
	}

	/**
	 * 获取指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @return 指定名称的参数值。
	 */
	@Override
	public Object getParameterValue(String name) {
		if (name == null || name.length() == 0) {
			return null;
		}

		switch (name.toLowerCase()) {
			case "userid":
				return this.userId;
			case "optype":
				return this.opType;
			case "tablenames":
				return this.tableNames;
			case "procname":
				return this.procName;
			case "success":
				return this.success;
			case "summary":
				return this.summary;
			case "body":
				return this.body;
			case "id":
				return this.id;
			default:
				return null;
		}
	}

	/**
	 * 设置指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @param value
	 * 			参数值。
	 * 
	 * @throws IllegalArgumentException
	 */
	@Override
	public void setParameterValue(String name, Object value) throws IllegalArgumentException {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("没有提供有效的参数名称。");
		}

		switch (name.toLowerCase()) {
			case "userid":
				this.userId = (java.util.UUID) value;
				break;
			case "optype":
				this.opType = (Byte) value;
				break;
			case "tablenames":
				this.tableNames = (String) value;
				break;
			case "procname":
				this.procName = (String) value;
				break;
			case "success":
				this.success = (Boolean) value;
				break;
			case "summary":
				this.summary = (String) value;
				break;
			case "body":
				this.body = (String) value;
				break;
			case "id":
				this.id = (Long) value;
				break;
			default:
				throw new IllegalArgumentException(name + " 不是 " + this.getClass().getName() + " 的有效参数属性名称。");
		}
	}

	/**
	 * 将当前对象作为 JSON 字符串写入指定的文本流。
	 * 
	 * @param writer
	 * 			目标文本流。
	 * 
	 * @throws IllegalArgumentException
	 * @throws java.io.IOException
	 */
	@Override
	public void write(java.io.Writer writer) throws IllegalArgumentException, java.io.IOException {
		if (writer == null) {
			throw new IllegalArgumentException("writer 为 null。");
		}

		writer.write('{');

		// 用户 Id
		writer.write("\"userId\":");
		pittypat.Json.write(writer, this.userId);
		writer.write(',');

		// 操作类型代码
		writer.write("\"opType\":");
		pittypat.Json.write(writer, this.opType);
		writer.write(',');

		// 数据库表名称
		writer.write("\"tableNames\":");
		pittypat.Json.write(writer, this.tableNames);
		writer.write(',');

		// 存储过程名称
		writer.write("\"procName\":");
		pittypat.Json.write(writer, this.procName);
		writer.write(',');

		// 是否成功
		writer.write("\"success\":");
		pittypat.Json.write(writer, this.success);
		writer.write(',');

		// 操作摘要
		writer.write("\"summary\":");
		pittypat.Json.write(writer, this.summary);
		writer.write(',');

		// 消息正文
		writer.write("\"body\":");
		pittypat.Json.write(writer, this.body);
		writer.write(',');

		// 消息 Id
		writer.write("\"id\":");
		pittypat.Json.write(writer, this.id);

		writer.write('}');
	}
}
